Import Gas Quality CSV Commands

Import: Gas Quality CSV

Import: Gas Quality CSV (IFCFGGQCSV via script) is a system-level command that triggers the service to import gas quality data via .csv files, according to the defined parameters, and send that information directly to the device.

In conjunction with the .csv file, an import definition file (.idf) can be used to customize the import. The .idf file defines details about how to import and format the data items in your .csv file. See Using an Import Definition File for more information about configuring this file.

Note: The Device (name) column is required; it can be located in any position.

This command does not automatically update the FMS database with the imported gas quality information. To also import the data into FMS, do one of the following to request the data from the device.

Automatically poll the device for configuration data - Prior to execution of the Import Gas Quality CSV command, set the Request config after successful send parameter to Yes to automatically poll the device for configuration data (including the gas quality data sent via the import) after the file import command succeeds.

Manually request configuration data from the device - After successful completion of the Import Gas Quality CSV command, execute a Request Current Configuration command to request configuration data from the device (including the gas quality data sent via the import).

You must have proper security authorization to execute this command. See FMS Security (and CMDSYS security event) for information about configuring security access for FMS commands.

See FMS ActiveX Controls and CxHmiFms for more information about using commands via FMS ActiveX controls on CygNet Studio or CygNet Vision screens.

See CxFms for more information about scripting commands.

Command Definition Properties

The following command definition properties apply to Import: Gas Quality CSV commands, when scheduling, creating, or editing commands via CygNet Explorer.

Property	Description
FMS service	Select a Site.Service for the command from the available FMS service list in the drop-down menu.
Command	Select the desired Command name from the drop-down menu. See FMS Commands for more information about available command types.
Priority	Select a processing queue Priority for the command from the drop-down menu. Options from least to greatest priority are as follows. Low level Medium level High level User initiated transaction Admin initiated transaction Default value is Low level processing queue priority.
Logging	Select a Logging level for the command results from the drop-down menu. Options are as follows. Low - displays errors Medium - displays errors and warnings High - displays errors, warnings, and status Default value is Low level logging when scheduling a command via the MSS service in CygNet Explorer. Default value is High level logging when creating or running an ad-hoc command in FMS Explorer or via the FMS service in CygNet Explorer.

Property

Description

FMS service

Select a Site.Service for the command from the available FMS service list in the drop-down menu.

Command

Select the desired Command name from the drop-down menu.

See FMS Commands for more information about available command types.

Priority

Select a processing queue Priority for the command from the drop-down menu.

Options from least to greatest priority are as follows.

Low level
Medium level
High level
User initiated transaction
Admin initiated transaction

Default value is Low level processing queue priority.

Logging

Select a Logging level for the command results from the drop-down menu.

Options are as follows.

Low - displays errors
Medium - displays errors and warnings
High - displays errors, warnings, and status

Default value is Low level logging when scheduling a command via the MSS service in CygNet Explorer.

Default value is High level logging when creating or running an ad-hoc command in FMS Explorer or via the FMS service in CygNet Explorer.

Command Parameters

The following command parameters apply to Import: Gas Quality CSV commands, when scheduling, creating, or editing commands via CygNet Explorer or scripting.

Parameter	Description	Type	Usage Notes
ImpPath	Import file directory	File Directory	Double-click to access the Enter Report File Directory dialog box. Type the directory location from which to import the file into the text box or click ... to access the Browse for Folder dialog box, browse to the directory location. Note: The directory specified is relative to the computer hosting the FMS service. This parameter is required.
ImpMask	Import file mask	String	If used, double-click to access the Enter Import File Mask dialog box. Type an import file mask name into the text box. Default file mask value is "*" (multiple character wildcard). If specified, only files meeting the file mask will be considered for import. This parameter is optional.
ImpClrPrc	Processed files retention (days)	Integer	If used, double-click to access the Enter Processed Files Retention (Days) dialog box. Type the number of days to retain the processed files into the text box. If specified, the files that have been processed will be deleted after the specified number of days. If not specified, processed files will never be deleted. This parameter is optional.
RptUnitSet	Unit set	Dynamic String Enum	If used, double-click to access the Unit Set dialog box. Select the name of the unit set in which to read the raw data. The list is populated by the unit sets defined in the service. See Configuring Unit Set Definitions for more information. This parameter is optional. *Notes: If you do not specify the unit set with this parameter, units for each included value must be specified using an .idf file. If you specify the unit set with this parameter AND in the .idf file, the value specified in the .idf file prevails, and overrides this setting. In this way, you may override individual unit values by setting them in the .idf file.
StatPtUdc	Status point UDC	String	If used, double-click to access the Enter Status Point UDC dialog box. Specify the UDC of the status point that monitors the status of the command. (The command will run whether or not it is monitored by a status point.) Type the status point UDC into the text box. The UDC will be combined with the field device Facility ID. This parameter is optional.
ImpGetCon	Request config after successful send	String Enum	Double-click to access the Request Config After Successful Send dialog box. Select whether or not to automatically request current configuration for the device once the gas quality data has been successfully sent. Options are as follows. Yes (YES via script) No (NO via script) Select Yes if you also want to automatically import the configuration data contained in the .csv file into FMS. Select No if you do not want to import the configuration data contained in the .csv file into FMS, or if you want to do so manually. This parameter is required.
ImpMxRun	Max runtime (minutes)	Integer	Double-click to access the Enter Max Run Time (minutes) dialog box. Enter the number of minutes to allow the command to run before the import will timeout. Note: Entering a value of 0 causes the command to run indefinitely. This parameter is required.
ImpRtrCnt	Communication attempt count	Integer	Double-click to access the Enter Communication Attempt Count dialog box. Enter the number of times to attempt the import before it will fail. This parameter is optional. *Notes: If you specify 0 for this value, the import will be attempted until it succeeds. If you do not specify a number, the default value is 1.
ImpGroup	Add devices to group	String	If used, double-click to access the Enter Add Devices to Group dialog box. Type the name of the group to which the imported devices will be added into the text box. If specified, devices will be added to this group when both of the following are true. The gas quality data send was successful If the value of ImpGetCon is Yes, the configuration poll was successful Note: Nodes added to this group are added for the entire span of the Node or group (whichever is less). This parameter is optional.
ImpClrGrp	Clear existing group entries	String Enum	If used, double-click to access the Clear Existing Group Entries dialog box. Select one of the following options. Yes (YES via script) No (NO via script) If set to Yes, and a value has been specified for ImpGroup, any existing entries will be removed from the specified group before executing the command. If set to No, the existing group entries will be retained when executing the command. Note: Nodes cleared from this group are cleared for the entire span of the Node or group. This parameter is optional.

Parameter

Description

Type

Usage Notes

ImpPath

Import file directory

File Directory

Double-click to access the Enter Report File Directory dialog box.

Type the directory location from which to import the file into the text box or click ... to access the Browse for Folder dialog box, browse to the directory location.

Note: The directory specified is relative to the computer hosting the FMS service.

This parameter is required.

ImpMask

Import file mask

String

If used, double-click to access the Enter Import File Mask dialog box.

Type an import file mask name into the text box. Default file mask value is "*" (multiple character wildcard).

If specified, only files meeting the file mask will be considered for import.

This parameter is optional.

ImpClrPrc

Processed files retention (days)

Integer

If used, double-click to access the Enter Processed Files Retention (Days) dialog box.

Type the number of days to retain the processed files into the text box.

If specified, the files that have been processed will be deleted after the specified number of days. If not specified, processed files will never be deleted.

This parameter is optional.

RptUnitSet

Unit set

Dynamic String Enum

If used, double-click to access the Unit Set dialog box.

Select the name of the unit set in which to read the raw data.

The list is populated by the unit sets defined in the service.

See Configuring Unit Set Definitions for more information.

This parameter is optional.

*Notes:

If you do not specify the unit set with this parameter, units for each included value must be specified using an .idf file.

If you specify the unit set with this parameter AND in the .idf file, the value specified in the .idf file prevails, and overrides this setting. In this way, you may override individual unit values by setting them in the .idf file.

StatPtUdc

Status point UDC

String

If used, double-click to access the Enter Status Point UDC dialog box.

Specify the UDC of the status point that monitors the status of the command. (The command will run whether or not it is monitored by a status point.)

Type the status point UDC into the text box. The UDC will be combined with the field device Facility ID.

This parameter is optional.

ImpGetCon

Request config after successful send

String Enum

Double-click to access the Request Config After Successful Send dialog box.

Select whether or not to automatically request current configuration for the device once the gas quality data has been successfully sent.

Options are as follows.

Yes (YES via script)
No (NO via script)

Select Yes if you also want to automatically import the configuration data contained in the .csv file into FMS.

Select No if you do not want to import the configuration data contained in the .csv file into FMS, or if you want to do so manually.

This parameter is required.

ImpMxRun

Max runtime (minutes)

Integer

Double-click to access the Enter Max Run Time (minutes) dialog box.

Enter the number of minutes to allow the command to run before the import will timeout.

Note: Entering a value of 0 causes the command to run indefinitely.

This parameter is required.

ImpRtrCnt

Communication attempt count

Integer

Double-click to access the Enter Communication Attempt Count dialog box.

Enter the number of times to attempt the import before it will fail.

This parameter is optional.

*Notes:

If you specify 0 for this value, the import will be attempted until it succeeds.

If you do not specify a number, the default value is 1.

ImpGroup

Add devices to group

String

If used, double-click to access the Enter Add Devices to Group dialog box.

Type the name of the group to which the imported devices will be added into the text box.

If specified, devices will be added to this group when both of the following are true.

The gas quality data send was successful
If the value of ImpGetCon is Yes, the configuration poll was successful

Note: Nodes added to this group are added for the entire span of the Node or group (whichever is less).

This parameter is optional.

ImpClrGrp

Clear existing group entries

String Enum

If used, double-click to access the Clear Existing Group Entries dialog box.

Select one of the following options.

Yes (YES via script)
No (NO via script)

If set to Yes, and a value has been specified for ImpGroup, any existing entries will be removed from the specified group before executing the command.

If set to No, the existing group entries will be retained when executing the command.

Note: Nodes cleared from this group are cleared for the entire span of the Node or group.

This parameter is optional.